home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dirut / bm_rm.zip / RM.DOC < prev    next >
Text File  |  1991-11-12  |  8KB  |  150 lines
  1. RM - Remove files and/or directory subtrees
  2.  
  3. Copyright (C) 1989, 1990, 1991 Brian B. McGuinness
  4.                                15 Kevin Road
  5.                                Scotch Plains, NJ 07076
  6.  
  7. This function is free software; you can redistribute it and/or modify it under 
  8. the terms of the GNU General Public License as published by the Free Software 
  9. Foundation; either version 1, or (at your option) any later version.
  10.  
  11. This function is distributed in the hope that it will be useful, but WITHOUT 
  12. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
  13. FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
  14. details.
  15.  
  16. You should have received a copy of the GNU General Public License along with 
  17. this function; if not, write to the Free Software Foundation, Inc., 675 Mass 
  18. Ave, Cambridge, MA 02139, USA.
  19.  
  20. --------------------------------------------------------------------------------
  21. WARNING: Careless use of this utility can lead to the loss of important data,
  22. directories, and/or program files.  Read the instructions carefully before
  23. using RM.  If files are accidentally deleted on a particular drive, use an
  24. unerase utility to recover the deleted files.  Directories may sometimes be
  25. recovered in a similar way.  Do NOT create or edit any other directories or
  26. files on that drive before recovery of the accidentally deleted material has
  27. been completed.  Unerase and directory unremoval utilities may be found as
  28. public domain or shareware programs on various bulletin board systems.  They
  29. may also be found in commercial software packages such as The Norton Utilities
  30. (TM), The Mace Utilities (TM), or PC-Tools (TM).
  31. --------------------------------------------------------------------------------
  32.  
  33. Syntax:  RM [/AEFIRSV?] {name | @}...
  34.  
  35. /A = Remove all matching files, even hidden and system files (these are not 
  36.      normally detected and removed).  If RM is used to remove files in the 
  37.      root directory of a bootable disk, especially a hard disk, /A should not 
  38.      be used with /F as there is a risk of removing the system files 
  39.      IBMBIO.COM (IO.SYS) and IBMDOS.COM (MSDOS.SYS).  This would make it 
  40.      impossible to boot the system from that disk.  
  41.  
  42. /E = Only delete matching files whose file size is zero.  Normally, we delete 
  43.      matching files regardless of their size.  This option is useful for 
  44.      disposing of empty "junk" files produced by programs or by failed 
  45.      attempts at I/O redirection.  For example, to remove ALL empty files from 
  46.      drive C:, use the command  RM /ES C:\*.*  (/S is explained below).  Note 
  47.      that empty files use up no disk space but they do use up a directory entry.
  48.  
  49. /F = Force deletion of files without asking.  Normally, we prompt the user for 
  50.      confirmation before removing read-only, hidden, or system files or before 
  51.      assuming "\*.*" at the end of a directory name (see /R below).  If the /F 
  52.      switch is used, these files are removed without any prompt being given.  
  53.      Do NOT use this switch unless you are absolutely sure that you know what 
  54.      you are doing.
  55.  
  56. /I = Interactive mode: the user is prompted for confirmation before each file 
  57.      is removed, regardless of the file's attributes.  This prompt will look 
  58.      something like:
  59.  
  60.      Delete C:\COMM\TEMP\RM.DOC  7685  16 Jul 1991  22:43  A-----  [N]? 
  61.  
  62.      The word "Delete" is followed by the full pathname of the file in 
  63.      question.  Next, the file size and the date and time of last modification 
  64.      are given.  Then the file's attributes are displayed: A = Archive (the 
  65.      file was modified since the last time it was backed up with the DOS 
  66.      BACKUP command), D = Directory and V = Volume label (these two never show 
  67.      up in the prompt), S = System file (part of DOS; if you remove these 
  68.      files you won't be able to boot from that disk), H = Hidden (the file is 
  69.      not displayed by the DOS DIR command), and R = Read-Only (can't be 
  70.      deleted by the DOS DEL command).  Dashes indicate attributes which aren't 
  71.      set.  The "[N]" means that the default response is "NO," so if you press 
  72.      any key other than "Y" or "y" (for "yes") the file will not be deleted.  
  73.      If you press the Esc key, RM will exit to DOS. 
  74.  
  75. /R = Recursively delete entire subtrees.  Normally, when a directory name 
  76.      appears on the command line it is treated as if "\*.*" was appended to 
  77.      it.  If the /R switch is used, RM will descend through any directory 
  78.      whose name is found on the command line and will remove that directory 
  79.      and all files and subdirectories contained within that directory.  
  80.      Removing the current default directory or any directory which contains 
  81.      the current default directory is not allowed. 
  82.  
  83.      If /I is also in effect, you will be prompted for confirmation before 
  84.      each directory is examined.  If you do not respond with 'Y' or 'y', that 
  85.      directory will be skipped.
  86.  
  87. /S = Delete matching files in an entire subtree.  For example, entering 
  88.      RM \UTIL\*.BAK  will delete all files in the \UTIL directory which have 
  89.      the extension .BAK.  Typing  RM /S \UTIL\*.BAK  will delete all .BAK 
  90.      files in the \UTIL directory and all subdirectories of \UTIL.  Typing 
  91.      RM /S *.DOC  will remove all .DOC files in the current default directory 
  92.      and all of its subdirectories.  /S ignores directory names: e.g., if you 
  93.      have a directory called \ASM, then typing RM /S \ASM will do nothing.  To 
  94.      remove all files in \ASM and its subdirectories, type RM /S \ASM\*.*.  
  95.      /S will only remove files, not directories.  Use /R to remove a whole 
  96.      subtree.
  97.  
  98. /V = Verbose: display the full pathname of each file or directory as it is 
  99.      removed.  Directory names are enclosed in brackets for ease of 
  100.      identification.
  101.  
  102. /? = Display instructions for using this program
  103.  
  104. Note: Switches become active as they are encountered on the command line.  If 
  105.       a switch is to affect a given file, it must appear before the file's 
  106.       name on the command line.  Moreover, switches may be combined (e.g. /AI 
  107.       is the same as /A /I).
  108.  
  109. name = The name of a file or directory to be removed.  Wildcards may be used.
  110.  
  111. @    = Read a list of names and/or switches from the standard input device and 
  112.        treat each of these as if it had been typed on the command line as an 
  113.        argument of RM.  More than one name and/or switch may appear on each 
  114.        line of input.  When an EOF is encountered, processing of the command 
  115.        line resumes.  
  116.  
  117.        This feature is useful when used with a file containing a lengthy list 
  118.        of names of files to be deleted.  It may also be used with any program 
  119.        which writes a list of file names to standard output: for example, a 
  120.        program which lists all files in a given directory which have not been 
  121.        modified since a certain date. 
  122.  
  123. If the environment string VERBOSE exists and has the value ON, then RM will 
  124. act as though the /V switch is in effect even if /V is not included on the 
  125. command line.  If you wish RM to always execute in verbose mode, you may find 
  126. it convenient to include the MS-DOS command  SET VERBOSE=ON  in your 
  127. AUTOEXEC.BAT file.
  128.  
  129. Examples:
  130.  
  131. The following command will remove all backup (.BAK) files on drive C:
  132.  
  133. RM /S C:\*.BAK
  134.  
  135. The following command will remove the directory A:\PASCAL and all files and 
  136. directories contained within A:\PASCAL, prompting the user for confirmation 
  137. before deleting each file:
  138.  
  139. RM /RI A:\PASCAL
  140.  
  141. This command will delete all files in the current directory whose names have 
  142. the extension .C or .H or .OBJ:
  143.  
  144. RM  *.C  *.H  *.OBJ
  145.  
  146. This command deletes all files whose names are given in the text file DELNAMES:
  147.  
  148. RM @ <DELNAMES
  149.  
  150.